Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Count how many shards were hit by routes when using vexplain #16802

Merged
merged 2 commits into from
Sep 19, 2024
Merged

Count how many shards were hit by routes when using vexplain #16802

merged 2 commits into from
Sep 19, 2024

Conversation

frouioui
Copy link
Member

@frouioui frouioui commented Sep 18, 2024 •
edited
Loading

Description

With this PR we will now track another metric for vexplain trace: the amount of shards hit by each route. This metric will enable us to know if a plan hits more or less shards for the same result, which is an useful indicator of performance.

After running the 30x local examples here is what we get:

mysql> vexplain trace select * from corder\G
*************************** 1. row ***************************
Trace: {
        "OperatorType": "Route",
        "Variant": "Scatter",
        "Keyspace": {
                "Name": "customer",
                "Sharded": true
        },
        "NoOfCalls": 1,
        "AvgNumberOfRows": 5,
        "MedianNumberOfRows": 5,
        "ShardsQueried": 2,
        "FieldQuery": "select order_id, customer_id, sku, price from corder where 1 != 1",
        "Query": "select order_id, customer_id, sku, price from corder",
        "Table": "corder"
}
1 row in set (0.00 sec)

mysql>

Related Issue(s)

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 18, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Sep 18, 2024
@frouioui frouioui removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 18, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 18, 2024
@frouioui frouioui marked this pull request as ready for review September 18, 2024 16:31
@frouioui frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving labels Sep 18, 2024
@codecov Codecov
Copy link

codecov bot commented Sep 18, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 97.05882% with 1 line in your changes missing coverage. Please review.

Project coverage is 69.53%. Comparing base (56c39b2) to head (71256ec).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtgate/engine/plan_description.go 91.66% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #16802   +/-   ##
=======================================
  Coverage   69.53%   69.53%           
=======================================
  Files        1567     1567           
  Lines      202388   202401   +13     
=======================================
+ Hits       140723   140745   +22     
+ Misses      61665    61656    -9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@systay systay merged commit ff1dea9 into vitessio:main Sep 19, 2024
97 checks passed
@systay systay deleted the count-shards-route branch September 19, 2024 07:47
systay pushed a commit that referenced this pull request Sep 20, 2024
@frouioui @systay
Count how many shards were hit by routes when using vexplain (#16802)
b6d26d7 
Signed-off-by: Florent Poinsard <[email protected]>
Signed-off-by: Andres Taylor <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@systay systay systay approved these changes

Assignees
No one assigned
Labels
Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v21.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@frouioui @systay @harshit-gangal @GuptaManan100